AWS S3

Общее описание

Компонент AWS2 S3 поддерживает хранение и извлечение объектов сервиса Amazon S3 и других S3 совместимых сервисов.

Блок AWS S3 может использоваться в качестве:

• блока – отправителя
• блока – получателя.

Настройка блока

В данном разделе описаны параметры блока AWS S3, которые необходимо заполнить при его настройке.

Базовые параметры

Название в UI	Название атрибута	Описание	Значение по умолчанию	Тип данных
Dynamic Endpoint	dynamicEndpoint	Доступен только для блоков-отправителей Параметр позволяет включить встроенную функциональность динамического определения вызываемой конечной точки. При включении параметра структура блока меняется таким образом, что в коде вместо определения "to" проставляется "toD", а значение самого вызываемого ресурса может собираться из переменной, например ${header.foo}.	False	Логическое значение
Pattern	pattern	Доступен только для блоков-отправителей. Устанавливает стиль взаимодействия с присоединенной частью потока. Возможные значения: InOnly — отправить без подтверждения приемки. При выборе в отправленном yaml и в режиме просмотра кода будет виден параметр pattern на том же уровне, что и uri. InОut — ждать подтверждения после отправки.
Connection	connection	Позволяет выбрать предсозданное подключение к конечной точке или создать новое с помощью визарда Connection Manager.		Список
Description	description	Описание блока		Строка
Bucket Name Or Arn	bucketNameOrArn	Обязательный параметр Название контейнера данных (бакета) или идентификатор ресурса в AWS.		Строка
Auto Create Bucket	autoCreateBucket	Настройка автоматического создания бакета в S3 хранилище с именем bucketName. Настройка также будет применяться в случае, если включена опция Move After Read, и при этом будет создан бакет для перемещения destinationBucket , если он еще не существует.	False	Логическое значение
Delimiter	delimiter	Разделитель, который используется в запросе com.amazonaws.services.s3.model.ListObjects для извлечения только определенных объектов.		Строка
Force Path Style	forcePathStyle	Определяет должен ли клиент S3 использовать URL-адрес в стиле path вместо URL-адреса в стиле виртуального хостинга.	False	Логическое значение
Ignore Body	ignoreBody	Если значение параметра равно True, то тело объекта S3 будет полностью проигнорировано. Если значение параметра равно False, то объект S3 будет помещен в тело.	False	Логическое значение
Override Endpoint	overrideEndpoint	Задает переопределение конечной точки. Этот параметр необходимо использовать в сочетании с параметром Uri Endpoint Override.	False	Логическое значение
Pojo Request	pojoRequest	Определяет будет ли использоваться POJO-запрос в качестве основного или нет.	False	Логическое значение
Policy	policy	Политика для очереди, задаваемая в методе com.amazonaws.services.s3.AmazonS3#setBucketPolicy().		Строка
Prefix	prefix	Префикс, который используется в com.amazonaws.services.s3.model.ListObjects для извлечения только определенных объектов.		Строка
Region	region	Регион, в котором должен работать клиент S3. Возможные значения: ap-south-2 ap-south-1 eu-south-1 eu-south-2 us-gov-east-1 me-central-1 il-central-1 ca-central-1 eu-central-1 us-iso-west-1 eu-central-2 eu-isoe-west-1 us-west-1 us-west-2 af-south-1 eu-north-1 eu-west-3 eu-west-2 eu-west-1 ap-northeast-3 ap-northeast-2 ap-northeast-1 me-south-1 sa-east-1 ap-east-1 cn-north-1 ca-west-1 us-gov-west-1 ap-southeast-1 ap-southeast-2 us-iso-east-1 ap-southeast-3 ap-southeast-4 us-east-1 us-east-2 cn-northwest-1 us-isob-east-1 aws-global aws-cn-global aws-us-gov-global aws-iso-global aws-iso-b-global		Список
Uri Endpoint Override	uriEndpointOverride	Задает переопределяющий uri конечной точки. Этот параметр необходимо использовать в сочетании с параметром Override Endpoint.		Строка
Batch Message Number	batchMessageNumber	Количество сообщений, составляющих пакет в режиме потоковой загрузки.	10	Целое число
Batch Size	batchSize	Размер пакета (в байтах) в режиме потоковой загрузки.	1000000	Целое число
Buffer Size	bufferSize	Размер буфера в байтах в режиме потоковой загрузки.	1000000	Целое число
Delete After Write	deleteAfterWrite	Задает удаление файлового объекта после того, как файл S3 будет загружен.	False	Логическое значение
Key Name	keyName	Установка уникального идентификатора для элемента в бакете с помощью параметра endpoint.		Строка
Multi Part Upload	multiPartUpload	Если значение параметра равно True, файл будет загружен частями. Размер части определяется параметром Part Size. Частями будут загружаться только файлы, размер которых превышает пороговые значения для размера части. Файлы меньшего размера будут загружены за одну операцию.	False	Логическое значение
Naming Strategy	namingStrategy	Стратегия присвоения имен, используемая в режиме потоковой загрузки. Возможные значения: progressive random	progressive	Список
Operation	operation	Операция, которая будет производиться в случае, если нужно выполнять не только загрузку. Возможные значения: copyObject listObjects deleteObject deleteBucket listBuckets getObject getObjectRange createDownloadLink		Список
Part Size	partSize	Задает размер части, который используется при частичной загрузке, по умолчанию он равен 25 МБ. Минимальный размер в AWS составляет 5 МБ. Частями будут загружаться только файлы, размер которых превышает пороговые значения для размера части. Файлы меньшего размера будут загружены за одну операцию.	26214400	Длинное целое число
Restarting Policy	restartingPolicy	Политика перезапуска, используемая в режиме потоковой загрузки. Возможные значения: override lastPart	override	Список
Storage Class	storageClass	Класс хранилища, который необходимо задать в запросе com.amazonaws.services.s3.model.PutObjectRequest.		Строка
Streaming Upload Mode	streamingUploadMode	Когда выбран режим потоковой передачи, загрузка в бакет будет выполняться в потоковом режиме.	False	Логическое значение
Streaming Upload Timeout	streamingUploadTimeout	Если выбран режим потоковой загрузки, то этот параметр устанавливает тайм-аут для завершения загрузки.		Длинное целое число
Proxy Host	proxyHost	Определяет прокси-сервер при создании экземпляра клиента SQS.		Строка
Proxy Port	proxyPort	Определяет прокси-порт, который будет использоваться в определении клиента.		Целое число
Proxy Protocol	proxyProtocol	Чтобы определить протокол прокси-сервера при создании экземпляра клиента S3 Возможные значения: HTTP HTTPS	HTTPS	Список
Backoff Error Threshold	backoffErrorThreshold	Количество последовательно полученных ошибок обработки, после которого включится режим пропуска запусков.		Целое число
Backoff Idle Threshold	backoffIdleThreshold	Количество последовательных запросов, которые не привели к созданию или обработке данных. После достижения установленного количества включится режим пропуска запусков.		Целое число
Backoff Multiplier	backoffMultiplier	Позволяет обработчику по расписанию включать режим пропуска запусков при достижении числа последовательных пустых запросов/ошибок. Этот параметр определяет количество запусков, которые будут пропущены. Когда используется этот параметр, также необходимо сконфигурировать Backoff Idle Threshold и/или Backoff Error Threshold.		Целое число
Delay	delay	Задержка в миллисекундах до следующего запроса.	500	Длинное целое число
Greedy	greedy	Если значение параметра установлено в True, то Scheduled Poll Consumer запустится сразу же после того как предыдущий запуск обработал одно или несколько сообщений.	False	Логическое значение
Initial Delay	initialDelay	Задержка в миллисекундах до начала первого запроса.	1000	Длинное целое число
Repeat Count	repeatCount	Задает максимальное количество срабатываний. Таким образом, если вы установите значение 1, планировщик сработает только один раз. Если вы установите значение 5, он сработает только пять раз. Нулевое или отрицательное значение означает, что срабатывание происходит постоянно.	0	Длинное целое число
Run Logging Level	runLoggingLevel	Уровень логгирования обработчика. Возможные значения: TRACE DEBUG INFO WARN ERROR OFF	TRACE	Список
Scheduled Executor Service	scheduledExecutorService	Позволяет настроить пользовательский/общий пул потоков для использования потребителем. По умолчанию у каждого потребителя есть свой собственный однопоточный пул потоков.		Строка
Scheduler	scheduler	Планировщик CRON из компонента camel-spring или camel-quartz. Используйте значение spring или quartz для встроенного планировщика.	none	Строка
Scheduler Properties	schedulerProperties	Множественное значение. Настройка дополнительных свойств при использовании пользовательского планировщика или любого из планировщиков на основе Quartz и Spring. Это многозначный параметр с префиксом: scheduler.		Строка
Start Scheduler	startScheduler	Задает автоматический запуск планировщика.	True	Логическое значение
Time Unit	timeUnit	Единица измерения времени для параметров Initial Delay и Delay. Возможные значения: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	MILLISECONDS	Список
Use Fixed Delay	useFixedDelay	Фиксированная задержка или фиксированная частота выполнения.	True	Логическое значение

Расширенные параметры

Название в UI	Название атрибута	Описание	Значение по умолчанию	Тип данных
Customer Algorithm	customerAlgorithm	Определяет пользовательский алгоритм работы , который будет использоваться в случае, если Use Customer Key включен.		Строка
Customer Key Id	customerKeyId	Определяет идентификатор клиентского ключа, который будет использоваться в случае, если Use Customer Key включен.		Строка
Customer Key MD5	customerKeyMD5	Определите MD5 клиентского ключа, который будет использоваться в случае, если Use Customer Key включен.		Строка
Aws KMSKey Id	awsKMSKeyId	Определяет идентификатор ключа KMS, который будет использоваться в случае, если KMS включена.		Строка
Lazy Start Producer	lazyStartProducer	Определяет должен ли отправитель стартовать в отложенном режиме (при получении первого сообщения). Отложенный запуск можно использовать в ситуациях, когда запуск отправителя может завершиться неудачей и привести к сбою при запуске маршрута. Если отложить запуск, то сбой при запуске можно будет обработать во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации. Примечание: При обработке первого сообщения создание и старт отправителя могут занять некоторое время и увеличить общее время обработки.	False	Логическое значение
Use Aws KMS	useAwsKMS	Определяет нужно ли использовать KMS или нет.	False	Логическое значение
Use Customer Key	useCustomerKey	Определяет должен ли использоваться ключ клиента или нет.	False	Логическое значение
Use SSES3	useSSES3	Определяет должен ли использоваться SSE S3 или нет.	False	Логическое значение
Amazon S3 Client	amazonS3Client	Ссылка на com.amazonaws.services.s3.AmazonS3 в реестре.		Строка
Amazon S3 Presigner	amazonS3Presigner	Автоматическое подключение интерфейса S3 Presigner для запроса, используемого в основном при работе с createDownloadLink		Строка
Disabled	disabled	Определяет будет ли отключен блок в потоке. В активированном потоке функциональность блока не будет отрабатываться.	False	Логическое значение

Параметры безопасности

Название в UI	Название атрибута	Описание	Значение по умолчанию	Тип данных
Access Key	accessKey	Ключ доступа к Amazon AWS.		Строка
Profile Credentials Name	profileCredentialsName	Если используется поставщик учетных данных профиля, то этот параметр задает имя профиля.		Строка
Secret Key	secretKey	Секретный ключ Amazon AWS.		Строка
Session Token	sessionToken	Токен сессии Amazon AWS, используемый, когда пользователю необходимо присвоить роль IAM.		Строка
Trust All Certificates	trustAllCertificates	Задает надо ли доверять всем сертификатам в случае переопределения конечной точки.	False	Логическое значение
Use Default Credentials Provider	useDefaultCredentialsProvider	Задает должен ли S3 клиент ожидать загрузки учетных данных через дефолтного поставщика учетных данных.	False	Логическое значение
Use Profile Credentials Provider	useProfileCredentialsProvider	Задает должен ли S3 клиент ожидать загрузки учетных данных через поставщика учетных данных профиля.	False	Логическое значение
Use Session Credentials	useSessionCredentials	Задает должен ли S3 клиент использовать учетные данные сессии. Это полезно в ситуации, когда пользователю необходимо принять на себя роль IAM для выполнения операций в S3.	False	Логическое значение